Skip to content

Cache git dirty files #2805

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
shitikanth wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Cache git dirty files #2805

shitikanth wants to merge 5 commits into from
+53 −9

Conversation

@shitikanth
Copy link

@shitikanth shitikanth commented Jan 9, 2026 •
edited
Loading

Attempts to fix #2816

The maven plugin recalculates the list of dirty files using GitRatchetMaven::getDirtyFiles for each maven module and FormatterFactory. Calculating the list is expensive for large git repositories.

This PR introduces a cache that stores the set of dirty files for a given (repository, ratchetFrom) combination and returns the cached value when available.

On a large git repository with >20 modules and >10k java files, this change reduces the time to run spotless:check from ~7s to <1s.

@shitikanth
Copy link
Author

shitikanth commented Jan 12, 2026

Impact on larger codebases is even more dramatic. For example, I tried testing the performance of spotless:check on real-world projects like apache/flink and aws-java-sdk-v2 by running mvn spotless:check -Dspotless.ratchetFrom=origin/master -Pspotless with the following profile added -

		<profile>
			<id>spotless</id>
			<build>
				<plugins>
					<plugin>
						<groupId>com.diffplug.spotless</groupId>
						<artifactId>spotless-maven-plugin</artifactId>
						<version>3.0.0</version>
						<configuration>
							<ratchetFrom>${spotless.ratchetFrom}</ratchetFrom>
							<java>
								<indent>
									<tabs>true</tabs>
									<spacesPerTab>4</spacesPerTab>
								</indent>
							</java>
						</configuration>
					</plugin>
				</plugins>
			</build>
		</profile>
project runtime (before) runtime (after)
aws/aws-sdk-java-v2 09:46 min 2.80 s
apache/flink 01:39 min 2.86 s

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Spotless maven plugin is slow on large project with several maven submodules

1 participant

@shitikanth